Modbus Omni EIE – Data Groups

Data Groups

With few exceptions, data groups must be defined in a device template file (DTF) in order for them to be available for use on a remote device. Which data groups are defined by a device template file depends on protocol, device type, and unique configuration.

CygNet distributes sample device template files for its EIEs, each of which typically serves one or more hardware models along with applicable firmware. Therefore, the data groups described below are only those data groups defined by CygNet in sample device template file(s). Your template(s) might not include some of the data groups described below. Device template files exist to enable users to customize device configurations; however, CygNet is not responsible for changes made by users.

For information about data group definitions and device template files, see Device Template Files.

For more information about data group dependencies, see Data Group Dependencies.

Notes:

When point processing is performed on history data groups, only closed records will be published and processed to points. If a device has leading timestamped records and returns the current, open record, point processing will not be performed for that record, even though there is data in the DDS transaction. The point record will be updated only when that record is closed. This is to avoid a situation where a point has multiple entries with the same timestamp, since an open record may be still updating values with each new poll, but each update will have the same timestamp. For example, say you start polling for a daily history record at 8:00am, you’ll get the first value at 8:00am, then if you poll every five minutes, you’ll get new values throughout the day at the exact same timestamp. A history record is basically an array of data with a timestamp and values where the values have different process variables for each incremental poll. The timestamp won’t get written until the record is closed, which happens at the end of the time period, in this case, a day.
Best practice recommends that you do not perform UDC and point processing on FMS data groups. The DEIDs specified in FMS data groups are generic and use the eFMS enumeration to identify the CygNet-defined FMS items referenced in the device template file. No polling is done on these data groups — all data is coming from the native data groups. Points should be mapped to the native data groups since that is the data group that is actually processing the device data. While point processing may work on the FMS data groups, it is not supported, not tested, not consistent across EIEs, and is not recommended practice.

Modbus Omni EIE Data Groups

Browse by letter: [A] [B] [C] [D] [F] [M] [P] [S]

Data Group Type	Usage Notes
ArchAlarm	"Archive Alarm" (11) is not user configurable. Archive data groups require a support data group to provide the last index for each archive. The support data group is configurable, based on available data. It can be ordinalized to correspond to archive ordinals, but this is not a requirement. Omni archive data groups follow the "Enron History Data Group" model, with only a slightly altered DateTime data group element, which uses the opTimeComp reference operation instead of the standard Enron HistDate and HistTime data group elements.
ArchAudit	"Archive Audit" (12) is not user configurable. Archive data groups require a support data group to provide the last index for each archive. The support data group is configurable, based on available data. It can be ordinalized to correspond to archive ordinals, but this is not a requirement. Omni archive data groups follow the "Enron History Data Group" model, with only a slightly altered DateTime data group element, which uses the opTimeComp reference operation instead of the standard Enron HistDate and HistTime data group elements.
ArchBatch	"Archive Batch" Archive data groups require a support data group to provide the last index for each archive. The support data group is configurable, based on available data. It can be ordinalized to correspond to archive ordinals, but this is not a requirement. Omni archive data groups follow the "Enron History Data Group" model, with only a slightly altered DateTime data group element, which uses the opTimeComp reference operation instead of the standard Enron HistDate and HistTime data group elements.
ArchDly	"Archive Daily" Archive data groups require a support data group to provide the last index for each archive. The support data group is configurable, based on available data. It can be ordinalized to correspond to archive ordinals, but this is not a requirement. Omni archive data groups follow the "Enron History Data Group" model, with only a slightly altered DateTime data group element, which uses the opTimeComp reference operation instead of the standard Enron HistDate and HistTime data group elements.
ArchStat	"Archive Status" Archive data groups require a support data group to provide the last index for each archive. The support data group is configurable, based on available data. It can be ordinalized to correspond to archive ordinals, but this is not a requirement. Omni archive data groups follow the "Enron History Data Group" model, with only a slightly altered DateTime data group element, which uses the opTimeComp reference operation instead of the standard Enron HistDate and HistTime data group elements.
ArchSupt	"Archive Support" Archive data groups require a support data group to provide the last index for each archive. The support data group is configurable, based on available data. It can be ordinalized to correspond to archive ordinals, but this is not a requirement. See supportDg, SupportDataGroup, and Ordinalized Data Group.
ArchVers	"Archive Version Info"
BatchPrev	"Batch Previous"
BatchRpt	"Batch Report" enables you to retrieve, display, and export a user-specified batch report. Its ordinals (1 - 8) represent the last 8 batch reports. You can easily export a report by clicking Options > Export Report on the data group dialog box.
CfgMB	The "Configurable Data Group" data group provides a flexible way to create custom data groups on a per-device basis. "Configurable Data" See Configurable Modbus Data Group.
Composite Data Group	The "Composite Data Group" is a special kind of data group that enables you to combine any data group element(s) from any data group(s) as long as they are in the same template as the composite data group. The "Composite Data Group" does not appear in a remote device editor unless it has been defined in the relevant device template file. See Composite Data Group.
DailyRpt	"Daily Report" enables you to retrieve, display, and export a daily report. Its ordinals (1 - 8) represent the last 8 daily reports. You can easily export a report by clicking Options > Export Report on the data group dialog box.
DateTime	"Date Time"
ExStatus	"Read Exception Status" See Read Exception Status Data Group.
FixedCfg	"Fixed Configuration"
FmsAlarm	"FMS Alarms" must include a support data group (supportDg) in its definition. The support data group must include dgCat="enronHistory" in its definition, and it must include blocking appropriate to history/archive data, not event/alarm data. See FMS Alarms Data Group.
FmsBatch	"FMS Batch" requires one of two support data groups (supportDg): "Archive Batch" or "Batch Previous". If "Archive Batch" is instantiated, always use it for "FMS Batch". If "Archive Batch" is not instantiated but "Batch Previous" is, "Batch Previous" is used for "FMS Batch". See FMS Batch Data Group.
FmsConfig	"FMS Configuration" must be retrieved before polling other FMS data groups of the same ordinal. See FMS Config Data Group.
FmsEvent	"FMS Events" must include a support data group (supportDg) in its definition. The support data group must include dgCat="enronHistory" in its definition, and it must include blocking appropriate to history/archive data, not event/alarm data. See FMS Events Data Group.
FmsHistD	"FMS Daily History" See FMS History Data Groups.
FmsProduct	"FMS Liquid Product" enables the retrieval of liquid product data by an associated CygNet Measurement system. See FMS Product Data Group.
MeterCfg	"Meter Config"
Product	"Product Data"
ProductM	"Product Meter Data"
ProverRpt	"Prover Report" enables you to retrieve, display, and export a prover report. Its ordinals (1 - 8) represent the last 8 prover reports. You can easily export a report by clicking Options > Export Report on the data group dialog box.
SnglCoilRo	"Single Read-Only Coil" See Single-Element Data Group.
SnglCoilRw	"Single Read/Write Coil" See Single-Element Data Group.
SnglRegRo2	"Single 2-byte R/O Register" See Single-Element Data Group.
SnglRegRo4	"Single 4-byte R/O Register" See Single-Element Data Group.
SnglRegRw2	"Single 2-byte R/W Register" See Single-Element Data Group.
SnglRegRw4	"Single 4-byte R/W Register" See Single-Element Data Group.